/* 
 * Enterprise Library Extensions - DI + ORM.
 * Copyright (C) 2006
 *
 * GNU General Public License
 *
 * This program is free software; you can redistribute 
 * it and/or modify it under the terms of the GNU General Public License 
 * as published by the Free Software Foundation; either version 2 of the 
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
 * See the GNU General Public License for more details.
 */
using System;
using System.Configuration;
using Microsoft.Practices.EnterpriseLibrary.Common.Configuration;

namespace ELE.EnterpriseLibrary.Data.Configuration
{
  /// <summary>
  /// Configuration data that defines a SQL query.
  /// <para>As an example:</para>
  /// <code>
  /// &lt;queries>
  ///  &lt;add name="GetEmployeeById" 
  ///         sql="select id, name, addressId, birthDate from employee e, employee_extra ee where e.id=@Id and ee.employeeId = e.id">
  ///    &lt;mappings>
  ///      &lt;add name="Mapping1" objectId="Employee">
  ///        &lt;bindings>
  ///          &lt;add name="Age" ignore="true"/>
  ///        &lt;/bindings>
  ///      &lt;/add>
  ///    &lt;/mappings>
  ///  &lt;/add>
  ///  &lt;add name="GetAddressById" 
  ///       queryBuilder="Generic" 
  ///       sql="select id, street, number, zip from address where id= :Id">
  ///    &lt;mappings>
  ///      &lt;add name="Mapping1" objectId="Address"/>
  ///    &lt;/mappings>
  ///  &lt;/add>
  ///&lt;/queries>
  /// </code>
  /// </summary>
  public class SqlQueryData : NamedConfigurationElement
  {
    private const string sqlProperty = "sql";
    private const string queryBuilderProperty = "queryBuilder";
    private const string mappingProperty = "mappings";
    /// <summary>
    /// Default empty constructor.
    /// </summary>
		public SqlQueryData()
		{
		}
    /// <summary>
    /// A query with an identifier.
    /// </summary>
    /// <param name="name"></param>
    public SqlQueryData(string name)
			: base(name)
		{
		}
    /// <summary>
    /// The SQL text to be used when running the query.
    /// </summary>
    [ConfigurationProperty(sqlProperty, IsRequired = true)]
		public string Sql
		{
      get { return (string)base[sqlProperty]; }
      set { base[sqlProperty] = value; }
		}
    /// <summary>
    /// A query builder to use for translating sql types and parsing the sql text to extract useful information from it.
    /// </summary>
    [ConfigurationProperty(queryBuilderProperty, IsRequired = false)]
    public string QueryBuilder
    {
      get { return (string)base[queryBuilderProperty]; }
      set { base[queryBuilderProperty] = value; }
    }
    /// <summary>
    /// A set of mappings to use for input parameters or/and results.
    /// </summary>
    [ConfigurationProperty(mappingProperty)]
    public NamedElementCollection<MappingReferenceData> Mappings
    {
      get
      {
        return (NamedElementCollection<MappingReferenceData>)base[mappingProperty];
      }
    }
  }
}
